3D Graphics Programming with QuickDraw 3D 1.5.4

Previous | QD3D Book | Overview | Chapter Contents | Next

Creating and Editing Pixmap Markers

QuickDraw 3D provides routines that you can use to create and manipulate pixmap markers. See "Markers" for the definition of a pixmap marker.

Q3PixmapMarker_New

You can use the Q3PixmapMarker_New function to create a new pixmap marker.

TQ3GeometryObject Q3PixmapMarker_New (
                     const TQ3PixmapMarkerData *pixmapMarkerData);
pixmapMarkerData
A pointer to a TQ3PixmapMarkerData structure.

DESCRIPTION

The Q3PixmapMarker_New function returns, as its function result, a new pixmap marker having the position, shape, offset, and attributes specified by the pixmapMarkerData parameter. If a new pixmap marker could not be created, Q3PixmapMarker_New returns the value NULL .

Q3PixmapMarker_Submit

You can use the Q3PixmapMarker_Submit function to submit an immediate pixmap marker for drawing, picking, bounding, or writing.

TQ3Status Q3PixmapMarker_Submit (
                     const TQ3PixmapMarkerData *pixmapMarkerData,
                     TQ3ViewObject view);
pixmapMarkerData
A pointer to a TQ3PixmapMarkerData structure.
view
A view.

DESCRIPTION

The Q3PixmapMarker_Submit function submits for drawing, picking, bounding, or writing the immediate pixmap marker whose position, shape, offset, and attribute set are specified by the pixmapMarkerData parameter. The pixmap marker is drawn, picked, bounded, or written according to the view characteristics specified in the view parameter.

SPECIAL CONSIDERATIONS

You should call this function only in a submitting loop.

Q3PixmapMarker_GetData

You can use the Q3PixmapMarker_GetData function to get the data associated with a pixmap marker.

TQ3Status Q3PixmapMarker_GetData (
                     TQ3GeometryObject geometry,
                     TQ3PixmapMarkerData *pixmapMarkerData);
geometry
A pixmap marker.
pixmapMarkerData
On exit, a pointer to a TQ3PixmapMarkerData structure.

DESCRIPTION

The Q3PixmapMarker_GetData function returns, through the pixmapMarkerData parameter, information about the pixmap marker specified by the geometry parameter. QuickDraw 3D allocates memory for the TQ3PixmapMarkerData structure internally; you must call Q3PixmapMarker_EmptyData to dispose of that memory.

Q3PixmapMarker_SetData

You can use the Q3PixmapMarker_SetData function to set the data associated with a pixmap marker.

TQ3Status Q3PixmapMarker_SetData (
                     TQ3GeometryObject geometry,
                     const TQ3PixmapMarkerData *pixmapMarkerData);
geometry
A pixmap marker.
pixmapMarkerData
A pointer to a TQ3PixmapMarkerData structure.

DESCRIPTION

The Q3PixmapMarker_SetData function sets the data associated with the pixmap marker specified by the geometry parameter to the data specified by the pixmapMarkerData parameter.

Q3PixmapMarker_EmptyData

You can use the Q3PixmapMarker_EmptyData function to release the memory occupied by the data structure returned by a previous call to Q3PixmapMarker_GetData .

TQ3Status Q3PixmapMarker_EmptyData (
                     TQ3PixmapMarkerData *pixmapMarkerData);
pixmapMarkerData
A pointer to a TQ3PixmapMarkerData structure.

DESCRIPTION

The Q3PixmapMarker_EmptyData function releases the memory occupied by the TQ3PixmapMarkerData structure pointed to by the pixmapMarkerData parameter; that memory was allocated by a previous call to Q3PixmapMarker_GetData .

Q3PixmapMarker_GetPosition

You can use the Q3PixmapMarker_GetPosition function to get the position of a pixmap marker.

TQ3Status Q3PixmapMarker_GetPosition (
                     TQ3GeometryObject pixmapMarker,
                     TQ3Point3D *position);
pixmapMarker
A pixmap marker.
position
On exit, the position of the specified pixmap marker.

DESCRIPTION

The Q3PixmapMarker_GetPosition function returns, in the position parameter, the location of the pixmap marker specified by the pixmapMarker parameter.

Q3PixmapMarker_SetPosition

You can use the Q3PixmapMarker_SetPosition function to set the position of a pixmap marker.

TQ3Status Q3PixmapMarker_SetPosition (
                     TQ3GeometryObject pixmapMarker,
                     const TQ3Point3D *position);
pixmapMarker
A pixmap marker.
position
The desired position of the specified pixmap marker.

DESCRIPTION

The Q3PixmapMarker_SetPosition function sets the position of the pixmap marker specified by the pixmapMarker parameter to the point specified in the position parameter.

Q3PixmapMarker_GetXOffset

You can use the Q3PixmapMarker_GetXOffset function to get the horizontal offset of a pixmap marker.

TQ3Status Q3PixmapMarker_GetXOffset (
                     TQ3GeometryObject pixmapMarker,
                     long *xOffset);
pixmapMarker
A pixmap marker.
xOffset
On exit, the horizontal offset of the specified pixmap marker.

DESCRIPTION

The Q3PixmapMarker_GetXOffset function returns, in the xOffset parameter, the horizontal offset of the pixmap marker specified by the pixmapMarker parameter.

Q3PixmapMarker_SetXOffset

You can use the Q3PixmapMarker_SetXOffset function to set the horizontal offset of a pixmap marker.

TQ3Status Q3PixmapMarker_SetXOffset (
                     TQ3GeometryObject pixmapMarker,
                     long xOffset);
pixmapMarker
A pixmap marker.
xOffset
The desired horizontal offset of the specified pixmap marker.

DESCRIPTION

The Q3PixmapMarker_SetXOffset function sets the horizontal offset of the pixmap marker specified by the pixmapMarker parameter to the value specified in the xOffset parameter.

Q3PixmapMarker_GetYOffset

You can use the Q3PixmapMarker_GetYOffset function to get the vertical offset of a pixmap marker.

TQ3Status Q3PixmapMarker_GetYOffset (
                     TQ3GeometryObject pixmapMarker,
                     long *yOffset);
pixmapMarker
A pixmap marker.
yOffset
On exit, the vertical offset of the specified pixmap marker.

DESCRIPTION

The Q3PixmapMarker_GetYOffset function returns, in the yOffset parameter, the vertical offset of the pixmap marker specified by the pixmapMarker parameter.

Q3PixmapMarker_SetYOffset

You can use the Q3PixmapMarker_SetYOffset function to set the vertical offset of a pixmap marker.

TQ3Status Q3PixmapMarker_SetYOffset (
                     TQ3GeometryObject pixmapMarker,
                     long yOffset);
pixmapMarker
A pixmap marker.
yOffset
The desired vertical offset of the specified pixmap marker.

DESCRIPTION

The Q3PixmapMarker_SetYOffset function sets the vertical offset of the pixmap marker specified by the pixmapMarker parameter to the value specified in the yOffset parameter.

Q3PixmapMarker_GetPixmap

You can use the Q3PixmapMarker_GetPixmap function to get the pixmap of a pixmap marker.

TQ3Status Q3PixmapMarker_GetPixmap (
                     TQ3GeometryObject pixmapMarker,
                     TQ3StoragePixmap *pixmap);
pixmapMarker
A pixmap marker.
pixmap
On exit, the pixmap of the specified pixmap marker.

DESCRIPTION

The Q3PixmapMarker_GetPixmap function returns, in the pixmap parameter, a pointer to the pixmap associated with the pixmap marker specified by the pixmapMarker parameter.

Q3PixmapMarker_SetPixmap

You can use the Q3PixmapMarker_SetPixmap function to set the pixmap of a pixmap marker.

TQ3Status Q3PixmapMarker_SetPixmap (
                     TQ3GeometryObject pixmapMarker,
                     const TQ3StoragePixmap *pixmap);
pixmapMarker
A pixmap marker.
pixmap
The desired pixmap of the specified pixmap marker.

DESCRIPTION

The Q3PixmapMarker_SetPixmap function sets the pixmap of the pixmap marker specified by the pixmapMarker parameter to that specified in the pixmap parameter. Q3PixmapMarker_SetPixmap copies the pixmap to internal QuickDraw 3D memory, so you can dispose of the specified pixmap after calling Q3PixmapMarker_SetPixmap .

© 1997 Apple Computer, Inc.

Previous | QD3D Book | Overview | Chapter Contents | Next